Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

• The PR has a single goal that is clear from the PR title and/or description.
• All code changes represent a single set of modifications that logically belong together.
• No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

• The code can be understood easily.
• Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
• There are no redundancies that can be removed by simple modularization/refactoring.
• There are no leftover debug statements or commented code sections.
• The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

• New functions and types are documented with a docstring or top-level comment.
• Relevant publications are referenced in docstrings (see example for formatting).
• Inline comments are used to document longer or unusual code sections.
• Comments describe intent ("why?") and not just functionality ("what?").
• If the PR introduces a significant change or new feature, it is documented in NEWS.md.

Testing

• The PR passes all tests.
• New or modified lines of code are covered by tests.
• New or modified tests run in less then 10 seconds.

Performance

• There are no type instabilities or memory allocations in performance-critical parts.
• If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

• The correctness of the code was verified using appropriate tests.
• If new equations/methods are added, a convergence test has been run and the results
  are posted in the PR.

Created with ❤️ by the Trixi.jl community.

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (fcf2652) 96.34% compared to head (9c66099) 96.34%.

@@            Coverage Diff             @@
##             main    #1736      +/-   ##
==========================================
- Coverage   96.34%   96.34%   -0.00%     
==========================================
  Files         451      451              
  Lines       35979    35996      +17     
==========================================
+ Hits        34662    34677      +15     
- Misses       1317     1319       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

EDIT: Outdated structure

The current thread implementation is not the cleanest.

    # Threaded memory for bounds checking routine with `BoundsCheckCallback`.
    # The first entry of each vector contains the maximum deviation since the last export.
    # In the second entry, the total maximum deviation is saved.
    idp_bounds_delta_threaded = Dict{Symbol, Vector{Vector{real(basis)}}}()
    for key in bound_keys
        idp_bounds_delta_threaded[key] = [zeros(real(basis), 2)
                                          for _ in 1:Threads.nthreads()]
    end

First, the "Dictionary-Layer" has to be first, since the call of Symbol("...") always creates a small amount of allocations.
I'm aware that the memory for the global maximum deviation for threads 2 to nthreads() aren't used right now. Maybe there is another way to implement this thread parallel bounds check.
(Idea: Use Dictionary with vectors of length nthreads() + 1. Use the first nthreads() entries are used to calculate the current deviations in parallel. Then, use last entry for global deviation, which is not needed to be parallel. This would save memory, but probably would confuse more....)

EDIT: Outdated structure

In the last commit (78957b7), I revised the memory structure for the IDP bounds check.
For a better understanding, the local and global component of the memory are now divided into 2 different variable. The local component needed to be thread-parallel-safe and is therefore initialized as a vector of length nthreads(). On the other hand, this was not required for the global maximum deviation component.